Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integration with Doc Prop #96

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Integration with Doc Prop #96

wants to merge 4 commits into from

Conversation

juliarocha
Copy link

@juliarocha juliarocha commented Jul 15, 2020

What did you change? *

Added integration with Doc Prop via markdown placeholder.

Why? *

Keeping the Store Components documentation up to date with the code and independent from manual documentation.

How to test it? *

Doc Prop working on some components:
https://juzon--appliancetheme.myvtex.com/docs/app/[email protected]/
https://juzon--appliancetheme.myvtex.com/docs/app/[email protected]/ (beta version - migration in PR)

Components without Doc Prop:
https://juzon--appliancetheme.myvtex.com/docs/app/vtex.flex-layout
https://juzon--appliancetheme.myvtex.com/docs/app/vtex.rich-text (current version)

Types of changes *

  • Bug fix (a non-breaking change which fixes an issue)
  • New feature (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Technical improvements

@vtex-io-ci-cd
Copy link

vtex-io-ci-cd bot commented Jul 15, 2020

Hi! I'm VTEX IO CI/CD Bot and I'll be helping you to publish your app! 🤖

Please select which version do you want to release:

  • Patch (backwards-compatible bug fixes)

  • Minor (backwards-compatible functionality)

  • Major (incompatible API changes)

And then you just need to merge your PR when you are ready! There is no need to create a release commit/tag.

  • No thanks, I would rather do it manually 😞

@vtex-io-docs-bot
Copy link

Beep boop 🤖

Thank you so much for keeping our documentation up-to-date ❤️

@juliarocha juliarocha marked this pull request as ready for review July 15, 2020 18:02
manifest.json Outdated Show resolved Hide resolved
react/components/CustomTags.tsx Outdated Show resolved Hide resolved
@gris
Copy link
Contributor

gris commented Jul 16, 2020

@juliarocha can you comment here some workspaces with your contributions. Examples with and without docprop, please?

Copy link
Collaborator

@victorhmp victorhmp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code looks good to me, but please provide a way for us to test it :)

Also, please fix the linting issues pointed out by GitHub. A yarn lint --fix might be enough.

@gris
Copy link
Contributor

gris commented Jul 20, 2020

Looking good. I would only fix the minor lint issues and put // eslint-disable-next-line before the docprop trigger lines.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants